codecs.StreamWriter

Module codecs :: Class StreamWriter

[show private | hide private]

Class StreamWriter

Codec --+
        |
       StreamWriter

Known Subclasses:: StreamWriter

Method Summary
	`__init__(self, stream, errors)` Creates a StreamWriter instance.
	`__enter__(self)`
	`__exit__(self, type, value, tb)`
	`__getattr__(self, name, getattr)` Inherit all other methods from the underlying stream.
	`reset(self)` Flushes and resets the codec buffers used for keeping state.
	`write(self, object)` Writes the object's contents encoded to self.stream.
	`writelines(self, list)` Writes the concatenated list of strings to the stream using .write().
Inherited from Codec
	`decode(self, input, errors)` Decodes the object input and returns a tuple (output object, length consumed).
	`encode(self, input, errors)` Encodes the object input and returns a tuple (output object, length consumed).

Method Details

init(self, stream, errors='strict')
(Constructor)

Creates a StreamWriter instance.

stream must be a file-like object open for writing
(binary) data.

The StreamWriter may use different error handling
schemes by providing the errors keyword argument. These
parameters are predefined:

 'strict' - raise a ValueError (or a subclass)
 'ignore' - ignore the character and continue with the next
 'replace'- replace with a suitable replacement character
 'xmlcharrefreplace' - Replace with the appropriate XML
                       character reference.
 'backslashreplace'  - Replace with backslashed escape
                       sequences (only for encoding).

The set of allowed parameter values can be extended via
register_error.

getattr(self, name, getattr=<built-in function getattr>)
(Qualification operator)

Inherit all other methods from the underlying stream.

reset(self)

Flushes and resets the codec buffers used for keeping state.

Calling this method should ensure that the data on the output is put into a clean state, that allows appending of new fresh data without having to rescan the whole stream to recover state.

write(self, object)

Writes the object's contents encoded to self.stream.

writelines(self, list)

Writes the concatenated list of strings to the stream using .write().

Generated by Epydoc 2.1 on Fri Aug 15 18:58:37 2008

http://epydoc.sf.net